Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: remove mimetype requirement from batch requests (rfc #4) #177

Merged
merged 2 commits into from
Oct 18, 2023

Conversation

lukeocodes
Copy link
Contributor

No description provided.

@codecov-commenter
Copy link

Codecov Report

All modified lines are covered by tests ✅

❗ No coverage uploaded for pull request base (alpha@e7ea664). Click here to learn what that means.

Additional details and impacted files
@@           Coverage Diff            @@
##             alpha     #177   +/-   ##
========================================
  Coverage         ?   70.40%           
========================================
  Files            ?       16           
  Lines            ?      517           
  Branches         ?      100           
========================================
  Hits             ?      364           
  Misses           ?      127           
  Partials         ?       26           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@dvonthenen dvonthenen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Taking a look at this and have a question on the change (mainly for my education purposes). Is the mimetype optional since it's being removed? Or is the mimetype being inferred by the file type in batch operations?

@lukeocodes
Copy link
Contributor Author

TL:DR; yes, the API only requires a mimetype of application/json. the rest of the time, we parse the rawdata against our own tech (avoiding specifics on a public comment)

I should have linked to the RFC!

deepgram/deepgram-sdk-architecture#4

This is an easy change, simplifies the interface, and matches the functionality of the API. But it is a breaking change, so it is a good idea to do it now while V3 (and the other SDKs major versions) are still alpha and pre-alpha.

@lukeocodes lukeocodes merged commit d15fab4 into alpha Oct 18, 2023
1 check passed
@lukeocodes lukeocodes deleted the lo/rfc-4-remove-mimetype-prerecorded branch October 18, 2023 16:42
lukeocodes added a commit that referenced this pull request Nov 2, 2023
* feat!: create new structure for isomorphic SDK

* feat: add commitlint

* feat: add test coverage for client

* chore: remove unused variables

* feat: sort out default options, tests for helpers

* fix: remove postinstall script

* chore: updating various bits and constants

* feat: laying out the structure of the new library

* feat: get requests working

* feat: add tests, prerecorded samples, prerecorded requests

* feat: working live transcription

* feat: rejig the architecture to more closely reflect the documented high-level architecture plan

* feat: storing the API domain as a URL object, easier to pass around all clients

* fix: missing endpoint from fetch requests to the API

* chore: update integration test samples for new usage pattern

* feat: types rewriten for all endpoints

* feat: add tests for making transcription requests

* fix: rename listen test to prerecorded test

* chore: reorder some imports for tidiness

* fix: rename project API to manage API in the main client

* feat: added manage and onprem tests, fixed issues caught by tests

* feat: large amount of tests, websocket tests, test server changes, fixes to types

* feat: test server and dockerfile

* feat: use the mock server's current address to run tests against

* feat: fixes to live stream client

* fix: fix event types

* fix: working live

* fix: string should be integer

* chore: link to RFC for conforming code

* chore: configure prerelease channels

* fix: case-sensitive file system issues on mac

* feat: marking alpha as a major release version (#166)

BREAKING CHANGE: complete rearchitecture of the Node/JavaScript SDK to work in browsers and Node.

* feat: export types and enums from main module (#167)

* feat: export enums and types from the main module

* fix: fix CI workflow not finding coverage report

* chore: switch from coveralls to codecov

* feat: remove test server code from sdk repo, and fix tests (#170)

* feat: remove duplicate example apps (#172)

* feat: update workflows so PRs run on all release channel PRs (#175)

* chore: ran npm audit

* chore: update workflows so CI runs on alpha pulls

* feat: remove mimetype requirement from batch requests (rfc #4) (#177)

* feat: remove mimetype requirement from local file transcirption (rfc #4)

* fix: fix stray array of boolean type (#179)

* feat: making schema's possible from request types (#180)

* feat: any typing of request options renamed to schema for schema type generation

* feat: rename request options types to schema

* feat: remove json from this repo

* fix: default to application/json when not provided deepgram/audio+video content-type (#181)

* fix: blob datatype issues where blob as arraybufferlike had no bytelength (#182)

* fix: remove unused package from lock

* fix: fixed blob data type issue where blob as arraybufferlike had no bytelength in the browser

* fix: remove erroneous browser check

* fix: we need node 18 to be blob friendly

* fix(types): nested arrays defined as singular tuples incorrectly (#184)

* fix(types): nested arrays in LiveTranscriptionEvent (#183)

* fix(types): this many array types were defined as singlular tuples - whoops

* chore(test): update tests for new mock API url

---------

Co-authored-by: Luke Wilson <[email protected]>

* feat: proxy, CORs, README rewrite (#185)

* feat: overhaul client interfaces and scoped option handling

* feat: add proxy options for REST calls in the browser, error for browser REST calls without proxy

* chore: update code snippets for v-3 (#186)

* chore: remove unused packages/vars

* feat: add captions as a dependency

* feat: small changes to docs

* feat: smol changes to README

* feat: smol changes to README again

* fix(readme): remove version from ESM include example

* fix(dependency): fix dependency issue caused by adding the captions library

* feat: export client/packages from the entryfile

---------

Co-authored-by: Sandra Rodgers <[email protected]>

---------

Co-authored-by: Luke Wilson <[email protected]>
Co-authored-by: Sandra Rodgers <[email protected]>
lukeocodes added a commit that referenced this pull request Nov 29, 2023
* feat!: promote v3.0.0-alpha.12 to v3.0.0-beta (#187)

* feat!: create new structure for isomorphic SDK

* feat: add commitlint

* feat: add test coverage for client

* chore: remove unused variables

* feat: sort out default options, tests for helpers

* fix: remove postinstall script

* chore: updating various bits and constants

* feat: laying out the structure of the new library

* feat: get requests working

* feat: add tests, prerecorded samples, prerecorded requests

* feat: working live transcription

* feat: rejig the architecture to more closely reflect the documented high-level architecture plan

* feat: storing the API domain as a URL object, easier to pass around all clients

* fix: missing endpoint from fetch requests to the API

* chore: update integration test samples for new usage pattern

* feat: types rewriten for all endpoints

* feat: add tests for making transcription requests

* fix: rename listen test to prerecorded test

* chore: reorder some imports for tidiness

* fix: rename project API to manage API in the main client

* feat: added manage and onprem tests, fixed issues caught by tests

* feat: large amount of tests, websocket tests, test server changes, fixes to types

* feat: test server and dockerfile

* feat: use the mock server's current address to run tests against

* feat: fixes to live stream client

* fix: fix event types

* fix: working live

* fix: string should be integer

* chore: link to RFC for conforming code

* chore: configure prerelease channels

* fix: case-sensitive file system issues on mac

* feat: marking alpha as a major release version (#166)

BREAKING CHANGE: complete rearchitecture of the Node/JavaScript SDK to work in browsers and Node.

* feat: export types and enums from main module (#167)

* feat: export enums and types from the main module

* fix: fix CI workflow not finding coverage report

* chore: switch from coveralls to codecov

* feat: remove test server code from sdk repo, and fix tests (#170)

* feat: remove duplicate example apps (#172)

* feat: update workflows so PRs run on all release channel PRs (#175)

* chore: ran npm audit

* chore: update workflows so CI runs on alpha pulls

* feat: remove mimetype requirement from batch requests (rfc #4) (#177)

* feat: remove mimetype requirement from local file transcirption (rfc #4)

* fix: fix stray array of boolean type (#179)

* feat: making schema's possible from request types (#180)

* feat: any typing of request options renamed to schema for schema type generation

* feat: rename request options types to schema

* feat: remove json from this repo

* fix: default to application/json when not provided deepgram/audio+video content-type (#181)

* fix: blob datatype issues where blob as arraybufferlike had no bytelength (#182)

* fix: remove unused package from lock

* fix: fixed blob data type issue where blob as arraybufferlike had no bytelength in the browser

* fix: remove erroneous browser check

* fix: we need node 18 to be blob friendly

* fix(types): nested arrays defined as singular tuples incorrectly (#184)

* fix(types): nested arrays in LiveTranscriptionEvent (#183)

* fix(types): this many array types were defined as singlular tuples - whoops

* chore(test): update tests for new mock API url

---------

Co-authored-by: Luke Wilson <[email protected]>

* feat: proxy, CORs, README rewrite (#185)

* feat: overhaul client interfaces and scoped option handling

* feat: add proxy options for REST calls in the browser, error for browser REST calls without proxy

* chore: update code snippets for v-3 (#186)

* chore: remove unused packages/vars

* feat: add captions as a dependency

* feat: small changes to docs

* feat: smol changes to README

* feat: smol changes to README again

* fix(readme): remove version from ESM include example

* fix(dependency): fix dependency issue caused by adding the captions library

* feat: export client/packages from the entryfile

---------

Co-authored-by: Sandra Rodgers <[email protected]>

---------

Co-authored-by: Luke Wilson <[email protected]>
Co-authored-by: Sandra Rodgers <[email protected]>

* fix: fix dependency issues up and downstream (#188)

* fix: find a fix to allow the client to work in either websocket environment (#199)

* fix: fixes issues 197 and 198 (#202)

* fix: closing the socket too early (#201)

* fix: a wild fix for this has appeared (#200)

* chore: update examples to match console missions [no ci] (#204)

* feat: update websocket to use w3cwebsocket for node/browser/edge worker examples (#205)

* feat: tightly couple the api key to the proxy logic, so an api can't mistakenly be made public (#206)

---------

Co-authored-by: Luke Wilson <[email protected]>
Co-authored-by: Sandra Rodgers <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants